docs: document supported architectures#7532
Open
puneetdixit200 wants to merge 2 commits into
Open
Conversation
Signed-off-by: Puneet Dixit <236133619+puneetdixit200@users.noreply.github.com>
dosubot
Bot
added
component/documentation
type/chore
There was a problem hiding this comment.
Pull request overview
Adds a new guide documenting which OS/architecture combinations are officially supported by Cortex release artifacts, helping operators choose the correct binaries/images/packages and setting expectations for unsupported platforms (Fixes #4753).
Changes:
- Add
docs/guides/supported-architectures.mddescribing supported architectures for container images, binaries (Cortex + query-tee), and OS packages. - Document that non-listed platforms are unsupported unless validated by the operator, and note no AVX requirement in release builds.
Comments suppressed due to low confidence (2)
docs/guides/supported-architectures.md:19
- The table uses “macOS” as the OS label, but elsewhere (and in release build targets) the OS selector is
darwin(GOOS). Since this page is meant to help users pick the right release asset name, consider usingdarwin(or “darwin (macOS)”) to match the actual artifact naming scheme.
| Cortex binary | Linux | `amd64`, `arm64` |
| Cortex binary | macOS | `amd64`, `arm64` |
| Query tee binary | Linux | `amd64`, `arm64` |
| Query tee binary | macOS | `amd64`, `arm64` |
docs/guides/supported-architectures.md:19
- “Query tee” is spelled with a space here, but the project consistently refers to the component and artifacts as
query-tee(eg,./cmd/query-tee,dist/query-tee-<os>-<arch>, anddocs/operations/query-tee.md). Renaming this row to “query-teebinary” would better match existing terminology and release asset names.
| Query tee binary | Linux | `amd64`, `arm64` |
| Query tee binary | macOS | `amd64`, `arm64` |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+7
to
+9
| Cortex release artifacts are built and tested for the architectures listed | ||
| below. Use these targets when selecting container images, binary artifacts, or | ||
| OS packages for production deployments. |
Member
There was a problem hiding this comment.
copilot is right, we don't test for macos
Signed-off-by: Puneet Dixit <rvit23bcs086.rvitm@rvei.edu.in>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does:
Adds a new documentation guide for Cortex's supported architectures. The page summarizes the supported release targets for container images, binaries, Debian packages, and RPM packages, and notes that other platforms should be treated as unsupported unless validated by the operator.
The documented targets were checked against the current Makefile release/build targets, CI architecture matrix, and latest published v1.21.0 release assets.
Which issue(s) this PR fixes:
Fixes #4753
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]docs/configuration/v1-guarantees.mdupdated if this PR introduces experimental flagsValidation performed:
I could not run the Hugo website build locally because
hugois not installed in this environment.AI assistance disclosure:
This documentation PR was prepared with OpenAI Codex assistance. AI was used to inspect repository policy/build files, draft the documentation text, and run local validation commands. The contribution remains submitted under the DCO signoff in the commit.